iT邦幫忙

2024 iThome 鐵人賽

DAY 17
0
生成式 AI

API: Swagger, Postman系列 第 17

Swagger 中的基本操作:添加路由和參數。

  • 分享至 

  • xImage
  •  

在 Swagger 中,你可以通過以下步驟來添加路由和參數。假設你正在使用 OpenAPI 规范(Swagger 2.0 或 3.0),以下是一些基本操作:

1. 添加路由

Swagger 2.0 示例

swagger: '2.0'
info:
  title: Sample API
  version: 1.0.0
paths:
  /users:
    get:
      summary: Get all users
      description: Returns a list of users
      responses:
        200:
          description: A list of users
          schema:
            type: array
            items:
              $ref: '#/definitions/User'

definitions:
  User:
    type: object
    properties:
      id:
        type: integer
      name:
        type: string

OpenAPI 3.0 示例

openapi: 3.0.0
info:
  title: Sample API
  version: 1.0.0
paths:
  /users:
    get:
      summary: Get all users
      description: Returns a list of users
      responses:
        '200':
          description: A list of users
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/User'

components:
  schemas:
    User:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string

2. 添加參數

查詢參數示例

如果您希望為 GET /users 添加一個查詢參數,例如 age

Swagger 2.0 示例

paths:
  /users:
    get:
      summary: Get all users
      description: Returns a list of users
      parameters:
        - name: age
          in: query
          description: Age of the user to filter
          required: false
          type: integer
      responses:
        200:
          description: A list of users
          schema:
            type: array
            items:
              $ref: '#/definitions/User'

OpenAPI 3.0 示例

paths:
  /users:
    get:
      summary: Get all users
      description: Returns a list of users
      parameters:
        - name: age
          in: query
          description: Age of the user to filter
          required: false
          schema:
            type: integer
      responses:
        '200':
          description: A list of users
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/User'

小結

以上就是在 Swagger 中添加路由和參數的基本操作。你可以根據需要擴展其他 HTTP 方法和參數類型(如路徑參數、請求體等)。這些基本結構可以幫助你開始構建和描述 API。


上一篇
如何在 Swagger 中生成 API 文檔。
下一篇
如何在 Swagger 中處理不同的 API 請求方法(GET、POST 等)。
系列文
API: Swagger, Postman30
圖片
  直播研討會
圖片
{{ item.channelVendor }} {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

尚未有邦友留言

立即登入留言